/*
 * Copyright 2020 StreamSets Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.streamsets.pipeline.lib.elasticsearch;

import java.net.URISyntaxException;

/**
 * Escapes characters of a path segment to make it compatible usable in a URL.
 */
public interface PathEscape {

  /**
   * Escapes characters of a path segment.
   *
   * @param path - raw path to escape.
   * @return escaped path.
   * @throws URISyntaxException - if the URI constructed using the path for some reason would be invalid.
   */
  String escape(String path) throws URISyntaxException;
}
